package top.lixunda.ecommerce.server.good.api.controller;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;
import top.lixunda.commerce.common.core.entity.MessageObject;
import top.lixunda.common.validate.XumValid;
import top.lixunda.ecommerce.server.good.api.entity.dto.GoodGroupInsertDTO;
import top.lixunda.ecommerce.server.good.api.entity.dto.GoodGroupUpdateDTO;
import top.lixunda.ecommerce.server.good.api.entity.vo.GoodGroupTreeVO;
import top.lixunda.ecommerce.server.good.api.entity.vo.GoodGroupVO;

import java.util.List;

/**
 * 店铺商品自定义分组管理
 *
 * @author Xumda
 * @version time:2020/2/6 22:23
 */
@Api("店铺商品自定义分组管理")
@RequestMapping("/good_group")
public interface IGoodGroupController {

    /**
     * 添加一个商品分组
     *
     * @param goodGroupInsertDTO 新添加的商品分组数据
     * @return 是否添加成功
     */
    @ApiOperation("添加一个商品分组")
    @PostMapping("insertGoodGroup")
    MessageObject<Boolean> insertGoodGroup(@RequestBody @XumValid GoodGroupInsertDTO goodGroupInsertDTO);

    /**
     * 更新一个商品分组
     *
     * @param goodGroupUpdateDTO 需要更新的商品分组数据
     * @return 是否更新成功
     */
    @ApiOperation("更新一个商品分组")
    @PostMapping("updateGoodGroup")
    MessageObject<Boolean> updateGoodGroup(@RequestBody @XumValid GoodGroupUpdateDTO goodGroupUpdateDTO);

    /**
     * 根据id删除商品分组，只删除该节点，其子节点全部放到父节点中去
     *
     * @param id 商品分组id
     * @return 是否删除成功
     */
    @ApiOperation("根据id删除商品分组，只删除该节点，其子节点全部放到父节点中去")
    @GetMapping("removeGoodGroupById")
    MessageObject<Boolean> removeGoodGroupById(@RequestParam("id") Integer id);

    /**
     * 根据id删除商品分组，只删除该节点，其子节点全部放到父节点中去
     *
     * @param ids 商品分组id
     * @return 是否删除成功
     */
    @ApiOperation("根据id删除商品分组，只删除该节点，其子节点全部放到父节点中去")
    @PostMapping("removeGoodGroupByIds")
    MessageObject<Boolean> removeGoodGroupByIds(@RequestBody List<Integer> ids);

    /**
     * 根据id删除商品分组，删除包括子节点的所有节点
     *
     * @param id 商品分组id
     * @return 是否删除成功
     */
    @ApiOperation("根据id删除商品分组，删除包括子节点的所有节点")
    @GetMapping("removeGoodGroupAllById")
    MessageObject<Boolean> removeGoodGroupAllById(@RequestParam("id") Integer id);

    /**
     * 根据id删除商品分组，删除包括子节点的所有节点
     *
     * @param ids 商品分组id
     * @return 是否删除成功
     */
    @ApiOperation("根据id删除商品分组，删除包括子节点的所有节点")
    @PostMapping("removeGoodGroupAllByIds")
    MessageObject<Boolean> removeGoodGroupAllByIds(@RequestBody List<Integer> ids);

    /**
     * 根据id获取分组数据信息
     *
     * @param id 分组id
     * @return 单条分组数据
     */
    @ApiOperation("根据id获取分组数据")
    @GetMapping("queryById")
    MessageObject<GoodGroupVO> queryById(@RequestParam("id") Integer id);

    /**
     * 查询整个分组树
     *
     * @return 分组树
     */
    @ApiOperation("查询整个分组树")
    @GetMapping("queryTree")
    MessageObject<GoodGroupTreeVO> queryTree();

    /**
     * 根据父节点id获取子类节点列表
     *
     * @param id 父节点id
     * @return 子节点列表
     */
    @ApiOperation("根据父节点id获取子类节点列表")
    @GetMapping("queryChildrenByParentId")
    MessageObject<List<GoodGroupVO>> queryChildrenByParentId(@RequestParam("id") Integer id);

    /**
     * 查询首层节点
     *
     * @return 首层节点
     */
    @ApiOperation("查询首层节点")
    @GetMapping("queryRoots")
    MessageObject<List<GoodGroupVO>> queryRoots();

}
